home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / daypack.zip / DAYPACK.DOC next >
Text File  |  1992-02-10  |  10KB  |  195 lines
  1.  
  2.                         ─╥──╖         ╥──╖         ╥
  3.                          ║  ║ ╓─┬ ╖ ╖ ╟──╜ ╓─┬ ╓── ╟/
  4.                         ─╨──╜ ╙─┴ ╙─╢ ╨    ╙─┴ ╙── ╨└
  5.                            (c)1992 by Gary Glueckert
  6.                           The SUNY BBS (516)420-0818
  7.                           For Non-Commercial use only.
  8.                               All rights reserved.
  9.  
  10.  
  11. Purpose:
  12. --------
  13.         DayPack was designed to help manage log files generated by such
  14. programs as bulletin board systems, communications programs, and the like.
  15. Originally, DayPack was written to handle the RBBS-PC "Callers" file but
  16. can now be used to handle practically any type of log file, including
  17. those generated by some door programs.
  18.  
  19. How it works:
  20. -------------
  21.         DayPack takes advantage of PKwares (R) PKZIP to compress log files and
  22. append a "daynumber" as the file extension. Therefore, a file compressed using
  23. DayPack on January 12th will have a file extension of .012 (eg: LOGFILE.012).
  24. Files may be processed on a daily, weekly, monthly, or filesize (in K) basis.
  25. Additionally, if you are processing the CALLERS file from RBBS-PC you have the
  26. option to first convert this file to a text file before compressing.
  27.  
  28. Running DayPack:
  29. ----------------
  30.         First and most importantly; PKZIP must be in your PATH or DayPack
  31. must be placed in the same directory as PKZIP. Running DayPack with no
  32. command-line parameters or switches will display a list of parameters which
  33. are available to you.
  34.  
  35. Command-Line Switches:
  36. ----------------------
  37.  
  38.    Usage: DAYPACK <filename> <Process> <Trigger> [Optional]
  39.  
  40.    <Filename> - This is the file that DayPack will process for you.
  41.                 Be sure to include the full Drive:\Path\Filename of the
  42.                 file unless it is in the current directory with DayPack.
  43.    <Process>  - Two options are available and you may supply both if
  44.                 needed.
  45.           /Cx - This is for RBBS-PC SysOps. It will convert the CALLERS
  46.                 file specified by <filename> and created by RBBS-PC to
  47.                 a readable text file.
  48.           /Zx - This will compress the file specified by <filename> into
  49.                 archive x (Drive:\Path\Filename). Do not include a file
  50.                 extension, this will be added by DayPack as the number
  51.                 of the day in the current year.
  52.    <Trigger>  - Only one of these options may be specified on the
  53.                 command-line. These paramters will determine WHEN DayPack
  54.                 is to process the file.
  55.           /D  - Process the file now! Used mostly for daily processing.
  56.           /Wn - Process the file weekly on day n, where n is specified
  57.                 as numbers 1 through 7, corresponding to the day of the
  58.                 week. 1=Sunday, 2=Monday,... ,7=Saturday and so forth.
  59.           /Mn - Process the file Monthly on day n, where n is equal to
  60.                 the day of the month. Ranges from 01 through 31.
  61.                 Note the use of a leading zero on single numbered days.
  62.           /Kn - Process the file if equal to or greater than this size
  63.                 in Kilobytes. Eg: /K20 means 20,000 bytes.
  64.    [Optional] - This cammand line parameter is optional and may be
  65.                 omitted.
  66.           /X  - Do NOT kill any of the files after processing them.
  67.                 Normally, DayPack will delete the old log files after
  68.                 it has converted or compressed them. To prevent this from
  69.                 happening use this command-line switch!
  70.  
  71. Using DayPack with RBBS-PC:
  72. ---------------------------
  73.         DayPack offers a great deal of flexibilty for use with the CALLERS
  74. file created by RBBS-PC. You may convert the callers file into a readable
  75. text file before compressing OR choose to convert and not compress it at all.
  76. You may also choose to simply compress the CALLERS file in it's original
  77. form without converting it. This is useful when you are using certain
  78. utilities that require the callers file and need to keep a backup of the
  79. file JUST IN CASE something goes wrong. Here is how I process my callers
  80. file monthly so that I can get both an original compressed backup AND
  81. a readable text file in one archive.
  82.  
  83. First I invoke DayPack like so:
  84.  
  85. DAYPACK C:\Rbbs\Callers /Zc:\rbbs\backup\callers /M01 /X
  86.         This invokes DayPack to compress the CALLERS file into the
  87.         archive c:\rbbs\backup\callers.xxx (xxx=Daynumber) without
  88.         converting it, on the first day of every month. NOTE that
  89.         DayPack will not delete the callers file at completion.
  90.  
  91. Then I invoke DayPack a second time like so:
  92.  
  93. DAYPACK C:\Rbbs\Callers /Cc:\rbbs\caller.txt /Zc:\rbbs\backup\callers /M01
  94.         This invokes DayPack to convert the callers file into a
  95.         readable text file called CALLER.TXT then compress it and add it
  96.         to the archive c:\rbbs\backup\callers.xxx (xxx=Daynumber), also
  97.         on the first day of every month. DayPack will then delete both
  98.         the CALLERS file AND the CALLER.TXT file it created.
  99.  
  100. Note that you can simply convert the CALLERS immediately by doin the
  101. following:
  102. DAYPACK C:\Rbbs\Callers /Ccaller.txt /D /X
  103.  
  104. Using DayPack on Log Files:
  105. ---------------------------
  106.         DayPack can also help you to manage any type of log or text file
  107. which tends to grow in size. For example, DayPack can take care of log
  108. files created by communications software simply by excluding the /C switch
  109. from the command-line. This will also manage log files created by some
  110. door programs such as GMon (John Morris' game monitor). This is especially
  111. usefull if you like to keep those log files around for reference.
  112.  
  113. Registration:
  114. -------------
  115.         Registration will elliminate the need for you to enter any key-press
  116. during the operation of DayPack. This allows you to use it in your nightly
  117. maintenance (RBBS) or during Boot-up to process files automatically.
  118.         The best thing about registration is that it is FREE for the asking!
  119. To register DayPack for free simply logon to out support BBS and ask for a
  120. registered copy. The SUNY BBS can be reached 24Hrs/day and 7 days/week at
  121. 516-420-0818. Please be sure to include a name for registration purposes.
  122. You will have to logon once again to download your copy. If you find DayPack
  123. to be a useful program please consider donating $5.00 to our BBS. Donations
  124. are NOT required for registration.
  125.  
  126. Make checks payable to:
  127.                 The SUNY BBS c/o The Auxiliary Services Corp.
  128. And send them to:
  129.                 Gary Glueckert
  130.                 The State University of New York at Farmingdale
  131.                 Dept. of Biological Sciences
  132.                 Farmingdale, NY  11735
  133.  
  134.         If you wish to have a registered version of DayPack mailed to you,
  135. send $10.00 in U.S. funds to the above address requesting a registration.
  136. Use the registration form included to help process your registration.
  137.  
  138.  
  139.  
  140. Limited License 
  141. ---------------
  142.         You are free to use DayPack without registration if for
  143.         Non-commercial use. Commercial use REQUIRES a paid registration!
  144.         You may NOT engage in, nor permit another party to engage in, any of 
  145.         the following:
  146.                 
  147.                 - Making alterations of any kind to this software, 
  148.                   documentation, or file archive containing this software.
  149.                 
  150.                 - Attempting to disassemble, decompile, or reverse engineer
  151.                   all or part of this software; including the files it 
  152.                   generates.
  153.                 
  154.                 - Grant a license or sub-license or any rights in the software 
  155.                   to others.
  156.         
  157.         You may distribute DayPack and post it for download on Bulletin
  158.         Boards given these restrictions:
  159.                 
  160.                 - The program shall be supplied in it's original and 
  161.                   unmodified form, which includes this documentation.
  162.                 
  163.                 - No fee is charged.
  164.                 
  165.                 - For profit use is prohibited without registration after
  166.                   a reasonable period of evaluation.
  167.                 
  168.                 - The program may not be included with other goods or 
  169.                   services. 
  170.                           
  171.         The author of this software grants you a license to use this software 
  172.         as long as the above conditions are met. Any violations of the above 
  173.         conditions will result in the termination of your license to use this 
  174.         software. Upon termination of this license, for any reason, you must 
  175.         stop using this software and destroy all copies of it in your 
  176.         posession. In addition the author reserves the right to cancel your 
  177.         license at any time for any reason that he sees fit.
  178.  
  179. Disclaimer:
  180. -----------
  181.         The author disclaims any warranties either expressed or implied, 
  182.         including, but not limited to, the applied warranties of 
  183.         mercantabilities or fitness for a particular purpose. All liability
  184.         for all possible damages which may be incurred from the use, or 
  185.         mis-use, of this product is solely with the user.
  186.  
  187.  
  188. Credits where credit is due:
  189. ----------------------------
  190. ** PKWARE and PKZIP are registered trademarks of PKWARE, Inc.
  191. ** GMon is Copyrighted 1992(c) by John Morris.
  192. ** DayPack is Copyrighted 1992(c) by Gary Glueckert.
  193.  
  194.  
  195.